home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / amos / amoslist-0295.lzh / AMOSLIST / text0125.txt < prev    next >
Encoding:
Text File  |  1995-03-01  |  2.2 KB  |  58 lines
  1.  
  2. As I stated in my last message, I have written an amigaguide help system
  3. for AMOSPro. This means that it will be possible to access help pages for
  4. your extension commands by pressing the help key over the command in the
  5. AMOSPro editor, just like the current system for builting AMOSPro commands.
  6.  
  7. However, for this to work, it is important that the following convention is
  8. used to name the nodes of your help file:
  9.  
  10.  
  11.     - Each node that describes a command should have the name 
  12.       C_<commandname> including any $ or # that is part of the
  13.       name, but with spaces removed. (Style unashamedly cribbed
  14.       from andy churches intution extension guide).
  15.  
  16.  
  17.     - If a node describes more than one command, add an additional
  18.       line beneath the @node line for each other command described
  19.       of the form:
  20.  
  21.         @AKA C_<othercommandname>
  22.  
  23.       All other amigaguide viewers will ignore these lines.
  24.  
  25.  
  26.     - As an extra feature, you may generate a hypertext link that when
  27.       pressed loads a program into a new window in the AMOSPro editor,
  28.       and exits help, like the original AMOSPro help did. The format
  29.       is:
  30.  
  31.         @{"<textlabel>" amos <filename>}
  32.  
  33.       where textlabel is the text to appear on screen as the link, and
  34.       filename is name of the file to load, which should be a complete
  35.       path, and not relative to the current directory.
  36.  
  37.       Such a link will be drawn by other amigaguide viewers, but will
  38.       have no effect when pressed.
  39.  
  40.  
  41. Please adjust you documentation to follow this style, as it will allow the
  42. user to integrate it into the new AMOSPro help system simply by copying it to
  43. the appropriate directory.
  44.  
  45.  
  46. +-------------------------+------------------------------------+
  47. |                         |    _____                           |
  48. | PAUL HICKMAN            |   /     \   ON A HOT SUMMER NIGHT  |
  49. | (ph@doc.ic.ac.uk)       |  /  O O  \  WOULD YOU  OFFER YOUR  |
  50. | DEPARTMENT OF COMPUTING | |    _    | THROAT  TO  THE  WOLF  |
  51. | IMPERIAL COLLEGE LONDON |  \  / \  /  WITH THE RED  ROSES ?  |
  52. |                         |   \_____/                          |
  53. +-------------------------+------------------------------------+
  54. Machines: Amiga 500  WB1.3 - 1mb Memory - External Disk Drive.
  55.           Amiga 1200 WB3.0 - 6mb Memory - 200Mb Hard Disk.
  56.  
  57.  
  58.